home *** CD-ROM | disk | FTP | other *** search
/ Aminet 25 / Aminet 25 (1998)(GTI - Schatztruhe)[!][Jun 1998].iso / Aminet / comm / uucp / DanNews.lha / DanNews.doc < prev    next >
Text File  |  1998-01-11  |  15KB  |  369 lines

  1. DanNews V1.8                                  10-Dec-97
  2. ------------
  3.  
  4. This is DanNews, a NNTP and UUCP news unbatcher. Unlike RNews, it's fast and
  5. it only takes as much memory as you let it.
  6.  
  7. The bad points are, when compared to RNews:
  8. - it can't forward articles on to other sites
  9. - it can't handle compressed batch files.
  10. These only matter if you get your news feed through UUCP (no problems for NNTP).
  11.  
  12.  
  13. What you need
  14. -------------
  15.  
  16. Kickstart 2 or above, a news set up that uses the UUNEWS: way of storing news
  17. articles, and a batch file (natch).
  18.  
  19.  
  20. Installing
  21. ----------
  22.  
  23. Do this...
  24.  
  25. - Copy DanNews to somewhere on your path.
  26.  
  27. - Don't delete RNews because some programs may still want to use it. Also
  28.   don't edit the RNews entry in UULIB:Config to DanNews because DanNews can't
  29.   post news, it's just an unbatcher.
  30.  
  31. - If it doesn't already exist, create the file UULIB:sitename or UUCP:sitename
  32.   to hold your full site name (eg. 'ramjam.demon.co.uk') needed for the PATH
  33.   and XREF options. It doesn't matter which one you use for DanNews, but other
  34.   tools may require one or the other (e.g. earlier versions of Tin used
  35.   UUCP:sitename, later versions use UULIB:sitename). Use both if you wish.
  36.  
  37. - Depending on your set up, you may need to alter other scripts which call
  38.   RNews to call to DanNews instead. Three set ups are below. If yours isn't
  39.   there and you don't know where the scripts are, CD to your Internet or UUCP
  40.   software directory and use 'search quick all #? RNews' to find out. Some
  41.   will be binary files and you can ignore them. Some scripts may not need
  42.   editing - definitely not the ones which post articles.
  43.  
  44. - Change the options if you like. The DELETE option can save a lot of grief.
  45.   YOU MUST READ ABOUT THE -H OPTION BELOW OR YOU COULD LOSE YOUR HARD DRIVE
  46.   PARTITION!
  47.  
  48. - It's done.
  49.  
  50.  
  51. Scripts to alter when installing
  52. --------------------------------
  53.  
  54. For AmigaDIS set up (version 3 or above)...
  55.  
  56. - Not much to do, since DanNews is used anyway. If you want to change the
  57.   options, the call to DanNews is in the DIS:C/NewsRead file. Type ReProtect
  58.   afterwards if your editor messed around with the protection bits.
  59.  
  60.  
  61. For AmigaDIS set up (version 2 or below)...
  62.  
  63. - Edit DIS:Read_News and replace RNews with DanNews. Type 'Protect Read_News
  64.   srwd' afterwards if your editor messed around with the protection bits.
  65.  
  66.  
  67. For AmiTCP-DIS set up...
  68.  
  69. - Edit AmiTCP:bin/NNTPTransfer and replace RNews with DanNews. Type 'Protect
  70.   NNTPTransfer srwd' afterwards if your editor messed around with the
  71.   protection bits.
  72.  
  73. - If you use PLink to dial up Demon instead of the normal Link than you'll
  74.   have to edit that instead. And protect it afterwards, mind.
  75.  
  76.  
  77. Options
  78. -------
  79.  
  80. DanNews FILE,BLIP/K/N,CACHE/K/N,DELETE/S,DELETEOVERVIEW/S,PATH/S,STATS/S,
  81.     XREF/S,-1/S,-H/S,-N/S,-T/K
  82.  
  83. Normal shell options. Give the option if you want to use it otherwise miss it
  84. out and some default will be used instead. The options beginning with '-' are
  85. compatible with RNews, by the way.
  86.  
  87. If you're not sure about the /LETTER stuff, /K/N means give a number after
  88. the option name, /K means give a string after the option name, and /S means
  89. just give the option name if you want to use it. FILE doesn't have anything
  90. after it 'cos it's special, bless it.
  91.  
  92.  
  93. Full list of options
  94. --------------------
  95.  
  96. Firstly, the file options. These are about how DanNews gets at the articles
  97. to unbatch and how it stores the unbatched articles. Usually you'll give it
  98. a batch file, but it'll accept standard input or piped stuff too. This means
  99. that other programs can do something exciting to the articles before passing
  100. them onto DanNews...
  101.  
  102. - FILE
  103.   The file to unbatch. If you don't give a file then standard input is used
  104.   instead. This means that other programs can re-direct or pipe stuff to it.
  105.   But it's slower.
  106.  
  107. - DELETE/S
  108.   Delete the batch file after a successful unbatch but keep it there if there
  109.   was an error. If you run a script from a Workbench icon to unbatch any new
  110.   news and delete the batch file afterwards then it's probably a good idea to
  111.   remove the delete command and set this switch instead. That way you have a
  112.   chance to see what's wrong instead of watching in horror as IconX carefully
  113.   deletes your last news download.
  114.  
  115. - DELETEOVERVIEW/S
  116.   Found out by accident that Tin 1.3 beta seems a lot faster if you delete
  117.   the .overview files and let it recreate them from scratch after each news
  118.   unbatch. So, I added a new option to do this.
  119.  
  120. - -N/S
  121.   Don't bother unbatching the file, but run through the program anyway. Maybe
  122.   useful if you want to test if the batch file's corrupt without using hard
  123.   disk space or to see how big the unbatch will be with the STATS option or
  124.   something.
  125.  
  126. - -T/K
  127.   If you unbatch from standard input then a tempory work file is made in T:.
  128.   You can change the directory of the work file by using this though - maybe
  129.   to disk if you're short of memory. If you're not using standard input it's
  130.   ignored. This is slightly different to RNews' -T.
  131.  
  132.  
  133. Next, the memory option. You can limit the amount of memory DanNews uses with
  134. this - either if you haven't got much memory or you want to be sure of being
  135. able to run other things as well as DanNews at the same time...
  136.  
  137. - CACHE/K/N
  138.   The maximum amount that it can allocate to the cache. If it's positive then
  139.   the cache will not go above that size - it could very well be less. If it's
  140.   negative then the cache will be at most that much less than the largest
  141.   block of memory you have (check with 'Avail'). The default is -100000.
  142.  
  143.  
  144. Now the display options. What appears on screen whilst you're twiddling your
  145. thumbs (or whatever else) when the unbatching happens...
  146.  
  147. - BLIP/K/N
  148.   Shows a display of how long there is to go before the unbatch is finished.
  149.   The number is how many articles are unbatched before the display's updated.
  150.   Not enough and you might slow down the computer with too much printing on
  151.   the screen. Too much and it's not very useful. I use 50.
  152.  
  153. - STATS/S
  154.   Display some statistics for each group when the unbatch has finished. If
  155.   you're a trainspotter you can re-direct these into a log file by using the
  156.   '>>filename' thing (see examples).
  157.  
  158.   For each newsgroup, the following statistics are provided:
  159.  
  160.   Number    the number of articles for this group
  161.   Xposts    the number of articles cross-posted into this group
  162.   Bytes     the total number of bytes unbatched to this group
  163.   Largest   the size in bytes of the largest article unbatched to this group
  164.  
  165.  
  166. Next the crossposting options. Crossposting means exactly the same article
  167. appearing in more than one group. You can tell when an article's crossposted
  168. when there's more than one name in the 'Newsgroups' header. Some people send
  169. a separate copy of the article to each group separately, there's not much
  170. DanNews can do about that.
  171.  
  172. There are three crossposting options - one gives your newsreader more details
  173. so it can do something clever with crossposted articles, one stops problems
  174. with dodgey file systems, and one turns off crossposting...
  175.  
  176. - XREF/S
  177.   Switch on cross referencing. This means DanNews makes 'Xref' headers that
  178.   let your newsreader keep track of all the groups crossposted articles
  179.   appear in. After that it's up to your newsreader - if yours supports Xref
  180.   then it'll probably mark the article as read in all the other groups as
  181.   well as the group you've just read it in so you don't bump into it later.
  182.   You have to have your site name set up properly for this to work.
  183.  
  184. - -H/S
  185.   Disable hardlinks. They're useful because the second, third, and so on
  186.   copies of articles in the 'Newsgroups' header are really only pointers to
  187.   the original, not complete copies. That means that only a few of bytes of
  188.   disk space are used instead of a few K. But if you don't use a file system
  189.   that supports hardlinks (ie. not FFS or AFS) then you get problems instead.
  190.   PROBLEMS CAN MEAN ANYTHING UP TO LOSING YOUR HARD DRIVE PARTITION. OFS AND
  191.   DC-FFS DON'T WORK PROPERLY WITH HARDLINKS - YOU MUST USE -H IF THE ARTICLES
  192.   ARE UNBATCHED TO A HARD DRIVE PARTITION THAT USES OFS OR DC-FFS!
  193.  
  194. - -1/S
  195.   Turn off crossposting. Only unbatches the article to the first group in the
  196.   'Newsgroups' header (or if that one isn't in UULIB:Newsgroups then go
  197.   through the header and find the first one which is and unbatch to that
  198.   group instead). The disadvantage with this is that you stand more chance of
  199.   missing the article unless you read every single article in every single
  200.   newsgroup.
  201.  
  202.   If you're quick you'll have realised that there'll never be hardlinks (no
  203.   -H) or more than one copy (-H) because there's never any crossposting. But
  204.   set up -H properly now in case you remove -1 and forget about -H in the
  205.   future.
  206.  
  207.  
  208. Now the Path option. If anyone knows of a use for this let me know...
  209.  
  210. - PATH/S
  211.   Alters the 'Path' header so that your site is put on last in the list. You
  212.   have to have your site name set up properly for this to work.
  213.  
  214.  
  215. Examples
  216. --------
  217.  
  218. Show a progress display which is updated too much, delete the batch file
  219. afterwards if there weren't any errors in it, and disable hardlinks...
  220.  
  221. - DanNews TCPIP:Spool/News/batch blip 1 delete -h
  222.  
  223.  
  224. Use at most 100K for the cache, update the 'Path' header, and generate
  225. cross references for your newsreader...
  226.  
  227. - DanNews TCPIP:Spool/News/batch cache 100000 path xref
  228.  
  229.  
  230. Make sure the cache leaves at least 500K free in the largest block of memory,
  231. display some statistics at the end, and run through the program but don't
  232. unbatch the file...
  233.  
  234. - DanNews TCPIP:Spool/News/batch cache -500000 stats -n
  235.  
  236.  
  237. Unbatch from a pipe, send the statistics to a log file, and use a tempory
  238. directory on the hard drive as a work file...
  239.  
  240. - DanNews <PIPE: -t Work:TempDir stats >>Work:LogDir/DanNewsLog
  241.  
  242.  
  243. Hints 'n' stuff
  244. ---------------
  245.  
  246. There are hints on the junk group, download errors, cache, and the control
  247. group. But firstly...
  248.  
  249. - YOU MUST READ ABOUT THE -H OPTION ABOVE OR YOU COULD LOSE YOUR HARD DRIVE
  250.   PARTITION!
  251.  
  252.  
  253. Junk group hints...
  254.  
  255. - The junk group is where articles go when the they're in none of the other
  256.   groups listed in UULIB:Newsgroups (or UULIB:DanNewsGroups).
  257.  
  258. - If you're lazy and were hoping to subscribe to many groups in one go by
  259.   using pattern matching (eg. alt.music.*) then think again, you've got to
  260.   list each group separately.
  261.  
  262.  
  263. Download error hints...
  264.  
  265. - DanNews 1.8 onwards should be *very* resilient when it comes to corrupt
  266.   batch files caused by failed downloads. If you do come across a problem,
  267.   please report it!  Please keep a copy of the batch file if at all 
  268.   possible, as it makes finding the problem a lot easier.
  269.  
  270. - To correct a corrupt batch file manually you have to delete the corrupt 
  271.   article from it. You can do this by loading it into an editor which doesn't
  272.   alter spaces to tabs or tabs to spaces (this is important), like CygnusEd
  273.   and MEmacs.  Next you have to remove the corrupt article(s) by deleting all
  274.   the lines from the '#! rnews <number>' before the corruption, up to (but not
  275.   including) the next '#! rnews <number>'. Save and try again. Hopefully it'll
  276.   work.
  277.  
  278.  
  279. Cache hints...
  280.  
  281. - The cache is at least the size of the largest article in the batch file (if
  282.   there's not this amount of memory free then DanNews will stop with an
  283.   error). At most it'll almost fill the largest block of memory you have.
  284.   Just how big it really is depends on how much free memory there is and how
  285.   big the batch file is - it doesn't HAVE to be any bigger than the largest
  286.   article but the more cache you have the faster DanNews will be.
  287.  
  288. - If you haven't got much memory or you want to limit the amount taken up by
  289.   DanNews so you can be sure of being able to use other programs at the same
  290.   time then you can use the CACHE option. The - number will probably be
  291.   better if you haven't got much memory, the + number will probably be better
  292.   if you have.
  293.  
  294. - If you download binaries and you're short of memory then you may get memory
  295.   errors until you set up the cache to the best size. If you get an error
  296.   saying that there's not enough memory for the cache then just increase it
  297.   (unless you haven't got the memory for it, in which case there's a
  298.   problem). If it's one saying that there's not enough memory for the header
  299.   buffer then DECREASE the cache a bit.
  300.  
  301. - If you're memory's been fragmented (if you've been using a lot of programs
  302.   or you've been on-line for a while or whatever) then do the usual trick of
  303.   closing windows, using 'Avail flush' from the shell, and trying again. If
  304.   that doesn't work reset the computer and try again. If that doesn't work
  305.   decrease the cache and try again. If that doesn't work...
  306.  
  307.  
  308. Control group hints...
  309.  
  310. - The program can unbatch control messages. If a message has a 'Control'
  311.   header then it's unbatched to control.<name>, for example control.newgroup
  312.   or control.rmgroup. But you've also got to put the group names of the
  313.   control messages you're bothered about into UULIB:Newsgroups (or
  314.   UULIB:DanNewsGroups) otherwise they'll get thrown into junk. The full list
  315.   of control messages are cancel, ihave, sendme, newgroup, rmgroup, sendsys,
  316.   version, and checkgroups.
  317.  
  318. - If you want, you can list some more groups in UULIB:DanNewsGroups. It's in
  319.   the same format as UULIB:Newsgroups. It lets you define groups that you
  320.   don't want your newsreader to show or your news poster to send out to
  321.   Usenet (eg. control groups). But remember that TrimNews doesn't trim the
  322.   groups listed in UULIB:DanNewsGroups, so you've got to sort that one out
  323.   yourself.
  324.  
  325.  
  326. Bugs
  327. ----
  328.  
  329. (Not so much a bug, more of a feature):
  330.  
  331. If you hit CTRL-C then you'll interrupt the unbatching before the .next files
  332. have been updated, so if you unbatch again you overwrite all of the articles
  333. that were created during the interrupted unbatch. But then again this isn't
  334. so bad 'cos you don't get duplicate articles if you unbatch the same batch
  335. file again (which you probably will do).
  336.  
  337.  
  338. Disclaimer
  339. ----------
  340.  
  341. If it trashes your news or blows up your computer or destroys the fabric of
  342. the universe or something then consider yourself warned. Use at your own risk
  343. and all that.
  344.  
  345.  
  346. Acknowlegements
  347. ---------------
  348.  
  349. Thanks to Dan for versions up to and including DanNews 1.4.
  350.  
  351.  
  352. Support
  353. -------
  354.  
  355. DanNews is now supported by Tim Corringham at Ramjam Consultants Ltd.
  356.  
  357. The most recent version will always be available on our web site:
  358.  
  359.   http://www.ramjam.demon.co.uk/
  360.  
  361. Please send any problem reports, comments, suggestions etc. to:
  362.  
  363.   support@ramjam.demon.co.uk
  364.  
  365. Many of the changes that have been made have been the result of user
  366. comments and suggestions - so please let us have your comments!
  367.  
  368. Enjoy!
  369.